feat(backend)!: Add backend to config and use `rustic_backend` #977

simonsan · 2023-12-31T02:05:13Z

BREAKING CHANGE:

Config structure changes

TODO:

how to deal with copy in a good way
decide on toml table names and structure, I would prefer it as storage and parse the provider, as in here:

- # Backend options: These options define which backend to use.
- [backend]
- repository = "/tmp/repo"
+ # Storage options: These options define which backend to use.
+ [storage]
+ provider = local
+ path = "/tmp/repo"

src/commands/key.rs

Cargo.toml

simonsan · 2023-12-31T02:13:47Z

Cargo.toml

@@ -63,6 +64,7 @@ log = { workspace = true }
 # serialization
 serde = { workspace = true }
 serde_json = { workspace = true }
+serde_path_to_error = { workspace = true }


TODO: Nice, but didn't really get it to work, could be nice for user facing errors though regarding misconfiguration.

simonsan · 2023-12-31T02:14:38Z

Cargo.toml

@@ -115,6 +122,8 @@ anyhow = "1"
 serde = { version = "1", features = ["serde_derive"] }
 serde_with = { version = "3.4", features = ["base64"] }
 serde_json = "1"
+serde_path_to_error = "0.1.14"
+toml_edit = { version = "0.21.0", features = ["serde"] }


TODO: remove, we have toml and toml_edit here, we only need the high-level crate (toml) for what we currently do.

Signed-off-by: simonsan <[email protected]> refactor: commands now use the new backend struct from rustic_backend Signed-off-by: simonsan <[email protected]> refactor: change config files and implement test to parse all config files with new settings for rustic_backend Signed-off-by: simonsan <[email protected]> fix: typo Signed-off-by: simonsan <[email protected]> style: dprint fmt Signed-off-by: simonsan <[email protected]> testing: use result Signed-off-by: simonsan <[email protected]>

Signed-off-by: simonsan <[email protected]>

simonsan · 2024-01-01T09:30:53Z

config/copy_example.toml

+[[copy]]
+# Second copy target
+[copy.options]
 password-file = "/root/key-rustic-ovh"
 cache-dir = "/var/lib/cache/rustic" # explicitly specify cache dir for remote repository
+
+[copy.backend]
+repository = "rclone|ovh:backup"
+repo-hot = "rclone|ovh:backup-hot"


@aawsome I think the naming is a bit off now, so we need to check what is best.

copy.options is essentially copy.repository.options.

Also it may be confusing to have [[copy]] twice, which is the right thing IMHO, because it is an array of backends in the ends, but maybe we can find a different approach, now that we may need to have a breaking change in the config?

simonsan · 2024-01-01T09:32:41Z

config/full.toml

-# Repository options: These options define which backend to use and which password to use.
-[repository]
+# Backend options: These options define which backend to use.
+[backend]
 repository = "/repo/rustic" # Must be set
 repo-hot = "/my/hot/repo" # Default: not set
-# one of the three password options must be set
+
+# Additional backend options - depending on backend. These can be only set in the config file.
+[backend.options]
+post-create-command = "par2create -qq -n1 -r5 %file" # Only local backend; Default: not set
+post-delete-command = "sh -c \"rm -f %file*.par2\"" # Only local backend; Default: not set
+retry = "default" # Only rest/rclone backend; Allowed values: "false"/"off", "default" or number of retries
+timeout = "10min" # Only rest/rclone backend
+
+# Repository options: These options define which repository settings and passwords to use.
+[repository]
+# Optional, but one of the three password options must be set
+# either on CLI, in the config file or in environment variables
 password = "mySecretPassword"
 password-file = "/my/password.txt"


I also don't really like the differentiation now:

[backend] repository = "" repo-hot = "" [backend.options] [repository]

Maybe we find some better naming there which makes it more clear?

Signed-off-by: simonsan <[email protected]>

simonsan · 2024-01-03T05:14:23Z

config/simple.toml

+# Backend options: These options define which backend to use.
+[backend]
 repository = "/tmp/repo"


Suggested change

# Backend options: These options define which backend to use.

[backend]

repository = "/tmp/repo"

# Storage options: These options define which backend to use.

[storage]

provider = local

path = "/tmp/repo"

simonsan · 2024-10-02T16:09:08Z

@aawsome I would close this, and we can talk about this approach, now that we have profile inheritance there might be better ways to deal with this? In any case, we can use this as a foundation.

simonsan commented Dec 31, 2023

View reviewed changes

src/commands/key.rs Outdated Show resolved Hide resolved

simonsan commented Dec 31, 2023

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

simonsan commented Dec 31, 2023

View reviewed changes

simonsan force-pushed the backend-config branch 2 times, most recently from 69e1941 to 199b6f0 Compare January 1, 2024 08:52

simonsan force-pushed the backend-config branch from 199b6f0 to 1683847 Compare January 1, 2024 08:59

simonsan added 4 commits January 1, 2024 10:02

Merge branch 'main' into backend-config

9cdf754

Signed-off-by: simonsan <[email protected]>

chore: update lockfile

cea65ca

Signed-off-by: simonsan <[email protected]>

fix: fix parsing of [[copy]] section

4eeb8d8

Signed-off-by: simonsan <[email protected]>

docs(config): fix some more descriptions

10b7c1c

Signed-off-by: simonsan <[email protected]>

simonsan commented Jan 1, 2024

View reviewed changes

WIP Temp settings

1ec83f6

Signed-off-by: simonsan <[email protected]>

simonsan commented Jan 3, 2024

View reviewed changes

Merge branch 'main' into backend-config

e9e8e52

aawsome mentioned this pull request Jan 7, 2024

No sftp support? rustic-rs/rustic_core#11

Closed

aawsome added 6 commits January 14, 2024 06:51

key add: Add additional options

bc49b67

fix path

78343aa

copy: Use target profile

9096ee1

use backend and repository flattened under repository

c3d74a6

use cli feature for rustic_backend

8af0ca4

fix clippy lint

aa56949

simonsan marked this pull request as draft January 28, 2024 17:11

simonsan mentioned this pull request Feb 3, 2024

release: rustic-rs v0.7.0 #1035

Merged

8 tasks

simonsan closed this Oct 2, 2024

simonsan added the C-zombie Category: A PR that was closed (by the author) but could still be of value label Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(backend)!: Add backend to config and use `rustic_backend` #977

feat(backend)!: Add backend to config and use `rustic_backend` #977

simonsan commented Dec 31, 2023 •

edited

Loading

simonsan Dec 31, 2023

simonsan Dec 31, 2023

simonsan Jan 1, 2024

simonsan Jan 1, 2024

simonsan Jan 3, 2024

simonsan commented Oct 2, 2024

feat(backend)!: Add backend to config and use rustic_backend #977

feat(backend)!: Add backend to config and use rustic_backend #977

Conversation

simonsan commented Dec 31, 2023 • edited Loading

simonsan Dec 31, 2023

Choose a reason for hiding this comment

simonsan Dec 31, 2023

Choose a reason for hiding this comment

simonsan Jan 1, 2024

Choose a reason for hiding this comment

simonsan Jan 1, 2024

Choose a reason for hiding this comment

simonsan Jan 3, 2024

Choose a reason for hiding this comment

simonsan commented Oct 2, 2024

feat(backend)!: Add backend to config and use `rustic_backend` #977

feat(backend)!: Add backend to config and use `rustic_backend` #977

simonsan commented Dec 31, 2023 •

edited

Loading